<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.codec.binary;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.apache.commons.codec.binary.BaseNCodec.EOF;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.FilterInputStream;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.InputStream;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.commons.codec.binary.BaseNCodec.Context;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Abstract superclass for Base-N input streams.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @since 1.5<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @version $Id: BaseNCodecInputStream.java 1429868 2013-01-07 16:08:05Z ggregory $<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>public class BaseNCodecInputStream extends FilterInputStream {<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>    private final BaseNCodec baseNCodec;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>    private final boolean doEncode;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>    private final byte[] singleByte = new byte[1];<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    private final Context context = new Context();<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>    protected BaseNCodecInputStream(final InputStream in, final BaseNCodec baseNCodec, final boolean doEncode) {<a name="line.44"></a>
<span class="sourceLineNo">045</span>        super(in);<a name="line.45"></a>
<span class="sourceLineNo">046</span>        this.doEncode = doEncode;<a name="line.46"></a>
<span class="sourceLineNo">047</span>        this.baseNCodec = baseNCodec;<a name="line.47"></a>
<span class="sourceLineNo">048</span>    }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    /**<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * {@inheritDoc}<a name="line.51"></a>
<span class="sourceLineNo">052</span>     *<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @return &lt;code&gt;0&lt;/code&gt; if the {@link InputStream} has reached &lt;code&gt;EOF&lt;/code&gt;,<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * &lt;code&gt;1&lt;/code&gt; otherwise<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @since 1.7<a name="line.55"></a>
<span class="sourceLineNo">056</span>     */<a name="line.56"></a>
<span class="sourceLineNo">057</span>    @Override<a name="line.57"></a>
<span class="sourceLineNo">058</span>    public int available() throws IOException {<a name="line.58"></a>
<span class="sourceLineNo">059</span>        // Note: the logic is similar to the InflaterInputStream:<a name="line.59"></a>
<span class="sourceLineNo">060</span>        //       as long as we have not reached EOF, indicate that there is more<a name="line.60"></a>
<span class="sourceLineNo">061</span>        //       data available. As we do not know for sure how much data is left,<a name="line.61"></a>
<span class="sourceLineNo">062</span>        //       just return 1 as a safe guess.<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>        return context.eof ? 0 : 1;<a name="line.64"></a>
<span class="sourceLineNo">065</span>    }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    /**<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * Marks the current position in this input stream.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * &lt;p&gt;The {@link #mark} method of {@link BaseNCodecInputStream} does nothing.&lt;/p&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span>     *<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * @param readLimit the maximum limit of bytes that can be read before the mark position becomes invalid.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * @since 1.7<a name="line.72"></a>
<span class="sourceLineNo">073</span>     */<a name="line.73"></a>
<span class="sourceLineNo">074</span>    @Override<a name="line.74"></a>
<span class="sourceLineNo">075</span>    public synchronized void mark(final int readLimit) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>    }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span>    /**<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * {@inheritDoc}<a name="line.79"></a>
<span class="sourceLineNo">080</span>     *<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @return always returns &lt;code&gt;false&lt;/code&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span>     */<a name="line.82"></a>
<span class="sourceLineNo">083</span>    @Override<a name="line.83"></a>
<span class="sourceLineNo">084</span>    public boolean markSupported() {<a name="line.84"></a>
<span class="sourceLineNo">085</span>        return false; // not an easy job to support marks<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * Reads one &lt;code&gt;byte&lt;/code&gt; from this input stream.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     *<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @return the byte as an integer in the range 0 to 255. Returns -1 if EOF has been reached.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @throws IOException<a name="line.92"></a>
<span class="sourceLineNo">093</span>     *             if an I/O error occurs.<a name="line.93"></a>
<span class="sourceLineNo">094</span>     */<a name="line.94"></a>
<span class="sourceLineNo">095</span>    @Override<a name="line.95"></a>
<span class="sourceLineNo">096</span>    public int read() throws IOException {<a name="line.96"></a>
<span class="sourceLineNo">097</span>        int r = read(singleByte, 0, 1);<a name="line.97"></a>
<span class="sourceLineNo">098</span>        while (r == 0) {<a name="line.98"></a>
<span class="sourceLineNo">099</span>            r = read(singleByte, 0, 1);<a name="line.99"></a>
<span class="sourceLineNo">100</span>        }<a name="line.100"></a>
<span class="sourceLineNo">101</span>        if (r &gt; 0) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>            final byte b = singleByte[0];<a name="line.102"></a>
<span class="sourceLineNo">103</span>            return b &lt; 0 ? 256 + b : b;<a name="line.103"></a>
<span class="sourceLineNo">104</span>        }<a name="line.104"></a>
<span class="sourceLineNo">105</span>        return EOF;<a name="line.105"></a>
<span class="sourceLineNo">106</span>    }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * Attempts to read &lt;code&gt;len&lt;/code&gt; bytes into the specified &lt;code&gt;b&lt;/code&gt; array starting at &lt;code&gt;offset&lt;/code&gt;<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * from this InputStream.<a name="line.110"></a>
<span class="sourceLineNo">111</span>     *<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * @param b<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *            destination byte array<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param offset<a name="line.114"></a>
<span class="sourceLineNo">115</span>     *            where to start writing the bytes<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * @param len<a name="line.116"></a>
<span class="sourceLineNo">117</span>     *            maximum number of bytes to read<a name="line.117"></a>
<span class="sourceLineNo">118</span>     *<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @return number of bytes read<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * @throws IOException<a name="line.120"></a>
<span class="sourceLineNo">121</span>     *             if an I/O error occurs.<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * @throws NullPointerException<a name="line.122"></a>
<span class="sourceLineNo">123</span>     *             if the byte array parameter is null<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * @throws IndexOutOfBoundsException<a name="line.124"></a>
<span class="sourceLineNo">125</span>     *             if offset, len or buffer size are invalid<a name="line.125"></a>
<span class="sourceLineNo">126</span>     */<a name="line.126"></a>
<span class="sourceLineNo">127</span>    @Override<a name="line.127"></a>
<span class="sourceLineNo">128</span>    public int read(final byte b[], final int offset, final int len) throws IOException {<a name="line.128"></a>
<span class="sourceLineNo">129</span>        if (b == null) {<a name="line.129"></a>
<span class="sourceLineNo">130</span>            throw new NullPointerException();<a name="line.130"></a>
<span class="sourceLineNo">131</span>        } else if (offset &lt; 0 || len &lt; 0) {<a name="line.131"></a>
<span class="sourceLineNo">132</span>            throw new IndexOutOfBoundsException();<a name="line.132"></a>
<span class="sourceLineNo">133</span>        } else if (offset &gt; b.length || offset + len &gt; b.length) {<a name="line.133"></a>
<span class="sourceLineNo">134</span>            throw new IndexOutOfBoundsException();<a name="line.134"></a>
<span class="sourceLineNo">135</span>        } else if (len == 0) {<a name="line.135"></a>
<span class="sourceLineNo">136</span>            return 0;<a name="line.136"></a>
<span class="sourceLineNo">137</span>        } else {<a name="line.137"></a>
<span class="sourceLineNo">138</span>            int readLen = 0;<a name="line.138"></a>
<span class="sourceLineNo">139</span>            /*<a name="line.139"></a>
<span class="sourceLineNo">140</span>             Rationale for while-loop on (readLen == 0):<a name="line.140"></a>
<span class="sourceLineNo">141</span>             -----<a name="line.141"></a>
<span class="sourceLineNo">142</span>             Base32.readResults() usually returns &gt; 0 or EOF (-1).  In the<a name="line.142"></a>
<span class="sourceLineNo">143</span>             rare case where it returns 0, we just keep trying.<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>             This is essentially an undocumented contract for InputStream<a name="line.145"></a>
<span class="sourceLineNo">146</span>             implementors that want their code to work properly with<a name="line.146"></a>
<span class="sourceLineNo">147</span>             java.io.InputStreamReader, since the latter hates it when<a name="line.147"></a>
<span class="sourceLineNo">148</span>             InputStream.read(byte[]) returns a zero.  Unfortunately our<a name="line.148"></a>
<span class="sourceLineNo">149</span>             readResults() call must return 0 if a large amount of the data<a name="line.149"></a>
<span class="sourceLineNo">150</span>             being decoded was non-base32, so this while-loop enables proper<a name="line.150"></a>
<span class="sourceLineNo">151</span>             interop with InputStreamReader for that scenario.<a name="line.151"></a>
<span class="sourceLineNo">152</span>             -----<a name="line.152"></a>
<span class="sourceLineNo">153</span>             This is a fix for CODEC-101<a name="line.153"></a>
<span class="sourceLineNo">154</span>            */<a name="line.154"></a>
<span class="sourceLineNo">155</span>            while (readLen == 0) {<a name="line.155"></a>
<span class="sourceLineNo">156</span>                if (!baseNCodec.hasData(context)) {<a name="line.156"></a>
<span class="sourceLineNo">157</span>                    final byte[] buf = new byte[doEncode ? 4096 : 8192];<a name="line.157"></a>
<span class="sourceLineNo">158</span>                    final int c = in.read(buf);<a name="line.158"></a>
<span class="sourceLineNo">159</span>                    if (doEncode) {<a name="line.159"></a>
<span class="sourceLineNo">160</span>                        baseNCodec.encode(buf, 0, c, context);<a name="line.160"></a>
<span class="sourceLineNo">161</span>                    } else {<a name="line.161"></a>
<span class="sourceLineNo">162</span>                        baseNCodec.decode(buf, 0, c, context);<a name="line.162"></a>
<span class="sourceLineNo">163</span>                    }<a name="line.163"></a>
<span class="sourceLineNo">164</span>                }<a name="line.164"></a>
<span class="sourceLineNo">165</span>                readLen = baseNCodec.readResults(b, offset, len, context);<a name="line.165"></a>
<span class="sourceLineNo">166</span>            }<a name="line.166"></a>
<span class="sourceLineNo">167</span>            return readLen;<a name="line.167"></a>
<span class="sourceLineNo">168</span>        }<a name="line.168"></a>
<span class="sourceLineNo">169</span>    }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span>    /**<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * Repositions this stream to the position at the time the mark method was last called on this input stream.<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * &lt;p&gt;<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * The {@link #reset} method of {@link BaseNCodecInputStream} does nothing except throw an {@link IOException}.<a name="line.174"></a>
<span class="sourceLineNo">175</span>     *<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * @throws IOException if this method is invoked<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * @since 1.7<a name="line.177"></a>
<span class="sourceLineNo">178</span>     */<a name="line.178"></a>
<span class="sourceLineNo">179</span>    @Override<a name="line.179"></a>
<span class="sourceLineNo">180</span>    public synchronized void reset() throws IOException {<a name="line.180"></a>
<span class="sourceLineNo">181</span>        throw new IOException("mark/reset not supported");<a name="line.181"></a>
<span class="sourceLineNo">182</span>    }<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span>    /**<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * {@inheritDoc}<a name="line.185"></a>
<span class="sourceLineNo">186</span>     *<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * @throws IllegalArgumentException if the provided skip length is negative<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * @since 1.7<a name="line.188"></a>
<span class="sourceLineNo">189</span>     */<a name="line.189"></a>
<span class="sourceLineNo">190</span>    @Override<a name="line.190"></a>
<span class="sourceLineNo">191</span>    public long skip(final long n) throws IOException {<a name="line.191"></a>
<span class="sourceLineNo">192</span>        if (n &lt; 0) {<a name="line.192"></a>
<span class="sourceLineNo">193</span>            throw new IllegalArgumentException("Negative skip length: " + n);<a name="line.193"></a>
<span class="sourceLineNo">194</span>        }<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span>        // skip in chunks of 512 bytes<a name="line.196"></a>
<span class="sourceLineNo">197</span>        final byte[] b = new byte[512];<a name="line.197"></a>
<span class="sourceLineNo">198</span>        long todo = n;<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span>        while (todo &gt; 0) {<a name="line.200"></a>
<span class="sourceLineNo">201</span>            int len = (int) Math.min(b.length, todo);<a name="line.201"></a>
<span class="sourceLineNo">202</span>            len = this.read(b, 0, len);<a name="line.202"></a>
<span class="sourceLineNo">203</span>            if (len == EOF) {<a name="line.203"></a>
<span class="sourceLineNo">204</span>                break;<a name="line.204"></a>
<span class="sourceLineNo">205</span>            }<a name="line.205"></a>
<span class="sourceLineNo">206</span>            todo -= len;<a name="line.206"></a>
<span class="sourceLineNo">207</span>        }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span>        return n - todo;<a name="line.209"></a>
<span class="sourceLineNo">210</span>    }<a name="line.210"></a>
<span class="sourceLineNo">211</span>}<a name="line.211"></a>




























































</pre>
</div>
</body>
</html>
